Skip to content

feat: add Writing Style semantic contract#375

Merged
rdmueller merged 4 commits into
LLM-Coding:mainfrom
raifdmueller:feat/writing-style-contract
Mar 27, 2026
Merged

feat: add Writing Style semantic contract#375
rdmueller merged 4 commits into
LLM-Coding:mainfrom
raifdmueller:feat/writing-style-contract

Conversation

@raifdmueller

@raifdmueller raifdmueller commented Mar 27, 2026

Copy link
Copy Markdown
Contributor

Summary

New contract: Writing Style — composes Wolf Schneider / Strunk & White with custom writing rules (keep English technical terms, address reader directly, headings as statements, show code, clear conclusions).

Good example of a contract that extends anchors with team-specific rules that don't exist as public anchors.

12 contracts total.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Neue Funktionen
    • Neue Schreibstil-Vorlage mit umfassenden Richtlinien für technische Texte in Deutsch und Englisch hinzugefügt (Sprache, Ton, Struktur, Konventionen für Code/Prompts, Absätze/Überschriften).
  • Dokumentation
    • Querverweise „Semantic Contract“ in mehreren abgelehnten Vorschlägen ergänzt; zwei neue Einträge dokumentiert; Tipp-Box zur Verwendung projekt­spezifischer Contracts hinzugefügt.
  • Tests
    • End-to-End-Tests an neue Navigationsstruktur angepasst.
  • Chores
    • Generierungstext-Formatierung für Inhaltsliste vereinfacht (keine Inhaltsänderung).

Composes Wolf Schneider / Strunk & White with project-specific rules:
- Technical terms stay English
- Address reader directly
- Headings as statements
- Show code, don't just claim
- Clear conclusions

Example of a contract that extends anchors with custom team rules.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Mar 27, 2026

Copy link
Copy Markdown
Contributor

Caution

Review failed

Pull request was closed or merged during review

Walkthrough

Ein neuer Vertragseintrag mit der ID "writing-style" wurde zu website/public/data/contracts.json hinzugefügt; außerdem wurden begleitende Dokumentations- und Testanpassungen sowie eine kleine Script-Redundanzbereinigung vorgenommen.

Changes

Cohort / File(s) Zusammenfassung
Neuer Vertragseintrag
website/public/data/contracts.json
Hinzufügen des Vertragsobjekts writing-style mit englischen/deutschen Titeln, Beschreibungen, Anker-Referenzen und ausführlichen template / templateDe-Richtlinien für technischen Schreibstil.
Dokumentation (abgelehnte Vorschläge)
docs/rejected-proposals.adoc, docs/rejected-proposals.de.adoc
Einfügen von „Now available“/Semantic-Contract-Links in mehrere Einträge, Hinzufügen zweier neuer abgelehnter Vorschläge (Spec-Driven Development, Explicit Contract Surface) und eines TIP-Blocks zur Definition von Semantic Contracts.
Build/Script
scripts/generate-llms-txt.js
Kleine Reformatierung: Ersetzen mehrzeiliger lines.push(...)-Blöcke durch einzelne lines.push(...)-Aufrufe und Komprimierung eines console.warn(...)-Aufrufs; keine inhaltliche Änderung.
End-to-end Tests
website/tests/e2e/website.spec.js
Anpassung von UI-Assertions: Home-Linktext von "Catalog" → "Anchors", Navigation über #more-menu-toggle für About/Contributing-Links und Umbenennung einer Rücknavigationserwartung.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 Minuten

Possibly related PRs

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed Der Titel beschreibt korrekt die Hauptänderung: das Hinzufügen eines neuen Semantic Contracts namens "Writing Style". Er ist präzise, spezifisch und fasst die primäre Änderung des Changesets zusammen.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

raifdmueller and others added 3 commits March 27, 2026 06:57
- TLDR → now "Concise Response" contract (BLUF + Strunk & White)
- ELI5 → now "Simple Explanation" contract (Feynman Technique)
- Spec-Driven Development → now "Specification" + "Requirements Discovery"
- Explicit Contract Surface → now "Layer Boundaries" contract
- Added tip: rejected anchors can live on as Semantic Contracts

Updated both EN and DE versions.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- "Catalog" → "Anchors" in nav text assertion
- About/Contributing tests now open More dropdown first
- "navigate back to Catalog" → "navigate back to Anchors"

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants